| Package | hl7.fhir.uv.tools.r3 |
| Type | StructureDefinition |
| Id | Id |
| FHIR Version | R3 |
| Source | http://hl7.org/fhir/tools/http://hl7.org/fhir/tools/0.3.0/StructureDefinition-CDSHooksRequest.html |
| Url | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksRequest |
| Version | 0.3.0 |
| Status | draft |
| Date | 2024-10-27T07:27:27+11:00 |
| Name | CDSHooksRequest |
| Title | CDSHooks Request (Logical Definition) |
| Experimental | True |
| Realm | uv |
| Authority | hl7 |
| Description | This structure is defined to allow the FHIR Validator to validate a CDSHooks Request Body. TODO: This content will be moved to the CDS Hooks specification in the future |
| Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksRequest |
| Kind | logical |
No resources found
| StructureDefinition | |
CDSHookContext  | CDS Hook Specific Context (Logical Definition) |
| CDSHooksElement | CDSHooks Services Base Extensible Element |
| CDSHookContext | CDS Hook Specific Context (Logical Definition) |
| CDSHooksElement | CDSHooks Services Base Extensible Element |
Note: links and images are rebased to the (stated) source
English
Generated Narrative: StructureDefinition CDSHooksRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CDSHooksRequest | C | 0..* | CDSHooksElement | Elements defined in Ancestors:extension The response to the discovery endpoint Instances of this logical model are not marked to be the target of a Reference cds-r-1: if fhirAuthorization details are provided, a fhirServer SHALL be specified |
  hook | 1..1 | code | The hook that triggered this CDS Service call | |
| hookInstance | 1..1 | uuid | A universally unique identifier (UUID) for this particular hook call When this element is read urn:uuid: is prefixed to the value before validation | |
| fhirServer | 0..1 | url | The base URL of the CDS Client's FHIR server | |
 fhirAuthorization | C | 0..1 | CDSHooksElement | A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token cds-r-2: If the granted SMART scopes include patient scopes (i.e. 'patient/'), the patient field SHOULD be populated to identify the FHIR id of that patient. |
 accessToken | 1..1 | string | This is the OAuth 2.0 access token that provides access to the FHIR server JSON Property Name: access_token | |
| tokenType | 1..1 | code | Fixed value: Bearer JSON Property Name: token_type Fixed Value: Bearer | |
| expiresIn | 1..1 | integer | The lifetime in seconds of the access token. JSON Property Name: expires_in | |
| scope | 1..1 | string | The scopes the access token grants the CDS Service | |
| subject | 1..1 | string | The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server | |
 patient | 0..1 | id | The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server | |
| context | 1..1 | CDSHookContext | Hook-specific contextual data that the CDS service will need JSON: If %resource.hook = 'patient-view'then the type isCDSHookPatientViewContextJSON: If %resource.hook = 'order-sign'then the type isCDSHookOrderSignContextJSON: If %resource.hook = 'order-select'then the type isCDSHookOrderSelectContext | |
 prefetch | 0..* | Base | Key/value pairs of FHIR queries the CDS Client provides on each call JSON: Represented as a single JSON Object with named properties using the value of the key child as the key | |
 key | 1..1 | code | Key of FHIR query - name for client to use when sending to Request | |
| value | 1..1 | Resource | Value of FHIR query - FHIR Query for client to perform Id may or not be present (this is the default for elements but not resources) JSON: This object can be represented as null in the JSON structure (which counts as 'present' for cardinality purposes) | |
| Documentation for this format | ||||
Spanish
Generated Narrative: StructureDefinition CDSHooksRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CDSHooksRequest | C | 0..* | CDSHooksElement | Elements defined in Ancestors:extension The response to the discovery endpoint Instances of this logical model are not marked to be the target of a Reference cds-r-1: if fhirAuthorization details are provided, a fhirServer SHALL be specified |
| hook | 1..1 | code | The hook that triggered this CDS Service call | |
| hookInstance | 1..1 | uuid | A universally unique identifier (UUID) for this particular hook call When this element is read urn:uuid: is prefixed to the value before validation | |
| fhirServer | 0..1 | url | The base URL of the CDS Client's FHIR server | |
| fhirAuthorization | C | 0..1 | CDSHooksElement | A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token cds-r-2: If the granted SMART scopes include patient scopes (i.e. 'patient/'), the patient field SHOULD be populated to identify the FHIR id of that patient. |
| accessToken | 1..1 | string | This is the OAuth 2.0 access token that provides access to the FHIR server JSON Property Name: access_token | |
| tokenType | 1..1 | code | Fixed value: Bearer JSON Property Name: token_type Fixed Value: Bearer | |
| expiresIn | 1..1 | integer | The lifetime in seconds of the access token. JSON Property Name: expires_in | |
| scope | 1..1 | string | The scopes the access token grants the CDS Service | |
| subject | 1..1 | string | The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server | |
| patient | 0..1 | id | The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server | |
| context | 1..1 | CDSHookContext | Hook-specific contextual data that the CDS service will need JSON: If %resource.hook = 'patient-view'then the type isCDSHookPatientViewContextJSON: If %resource.hook = 'order-sign'then the type isCDSHookOrderSignContextJSON: If %resource.hook = 'order-select'then the type isCDSHookOrderSelectContext | |
| prefetch | 0..* | Base | Key/value pairs of FHIR queries the CDS Client provides on each call JSON: Represented as a single JSON Object with named properties using the value of the key child as the key | |
| key | 1..1 | code | Key of FHIR query - name for client to use when sending to Request | |
| value | 1..1 | Resource | Value of FHIR query - FHIR Query for client to perform Id may or not be present (this is the default for elements but not resources) JSON: This object can be represented as null in the JSON structure (which counts as 'present' for cardinality purposes) | |
| Documentation for this format | ||||
FHIR{
"resourceType" : "StructureDefinition",
"id" : "CDSHooksRequest",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div xml:lang=\"en\" lang=\"en\"><hr/><p><b>English</b></p><hr/><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition CDSHooksRequest</b></p><a name=\"CDSHooksRequest\"> </a><a name=\"hcCDSHooksRequest\"> </a><a name=\"CDSHooksRequest-en\"> </a><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest\" title=\"The response to the discovery endpoint\">CDSHooksRequest</a><a name=\"CDSHooksRequest\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;\" href=\"http://hl7.org/fhir/R5/conformance-rules.html#constraints\" title=\"This element has or is affected by constraints ( cds-r-1 )\">C</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-CDSHooksElement.html\">CDSHooksElement</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><br/>Elements defined in Ancestors:<a href=\"StructureDefinition-CDSHooksElement.html\" title=\"A JSON object that has properties where the names are defined by the extension definitions\">extension</a><br/>The response to the discovery endpoint<br/><span style=\"font-weight:bold\">Instances of this logical model are not marked to be the target of a Reference</span><br/><span style=\"font-weight:bold\">cds-r-1: </span>if fhirAuthorization details are provided, a fhirServer SHALL be specified</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.hook\" title=\"The hook that triggered this CDS Service call\">hook</a><a name=\"CDSHooksRequest.hook\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#code\">code</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The hook that triggered this CDS Service call</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.hookInstance\" title=\"While working in the CDS Client, a user can perform multiple actions in series or in parallel. For example, a clinician might prescribe two drugs in a row; each prescription action would be assigned a unique hookInstance. This allows a CDS Service to uniquely identify each hook invocation\">hookInstance</a><a name=\"CDSHooksRequest.hookInstance\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#uuid\">uuid</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">A universally unique identifier (UUID) for this particular hook call<br/>When this element is read <code>urn:uuid:</code> is prefixed to the value before validation</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.fhirServer\" title=\"The base URL of the CDS Client's FHIR server. If fhirAuthorization is provided, this field is REQUIRED. The scheme MUST be https when production data is exchanged\">fhirServer</a><a name=\"CDSHooksRequest.fhirServer\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#url\">url</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The base URL of the CDS Client's FHIR server</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck11.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization\" title=\"A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token\">fhirAuthorization</a><a name=\"CDSHooksRequest.fhirAuthorization\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;\" href=\"http://hl7.org/fhir/R5/conformance-rules.html#constraints\" title=\"This element has or is affected by constraints ( cds-r-2 )\">C</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-CDSHooksElement.html\">CDSHooksElement</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token<br/><span style=\"font-weight:bold\">cds-r-2: </span>If the granted SMART scopes include patient scopes (i.e. 'patient/'), the patient field SHOULD be populated to identify the FHIR id of that patient.</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck110.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization.accessToken\" title=\"This is the OAuth 2.0 access token that provides access to the FHIR server\">accessToken</a><a name=\"CDSHooksRequest.fhirAuthorization.accessToken\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">This is the OAuth 2.0 access token that provides access to the FHIR server<br/><span style=\"font-weight:bold\">JSON Property Name: </span>access_token</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck110.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization.tokenType\" title=\"Fixed value: Bearer\">tokenType</a><a name=\"CDSHooksRequest.fhirAuthorization.tokenType\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#code\">code</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Fixed value: Bearer<br/><span style=\"font-weight:bold\">JSON Property Name: </span>token_type<br/><span style=\"font-weight:bold\">Fixed Value: </span><span style=\"color: darkgreen\">Bearer</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck110.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization.expiresIn\" title=\"The lifetime in seconds of the access token.\">expiresIn</a><a name=\"CDSHooksRequest.fhirAuthorization.expiresIn\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#integer\">integer</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The lifetime in seconds of the access token.<br/><span style=\"font-weight:bold\">JSON Property Name: </span>expires_in</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck110.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization.scope\" title=\"The scopes the access token grants the CDS Service\">scope</a><a name=\"CDSHooksRequest.fhirAuthorization.scope\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The scopes the access token grants the CDS Service</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck110.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization.subject\" title=\"The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server\">subject</a><a name=\"CDSHooksRequest.fhirAuthorization.subject\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck100.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization.patient\" title=\"The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server\">patient</a><a name=\"CDSHooksRequest.fhirAuthorization.patient\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#id\">id</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.context\" title=\"Hook-specific contextual data that the CDS service will need\">context</a><a name=\"CDSHooksRequest.context\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-CDSHookContext.html\">CDSHookContext</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Hook-specific contextual data that the CDS service will need<br/>JSON: If<code>%resource.hook = 'patient-view'</code>then the type is<a href=\"StructureDefinition-CDSHookPatientViewContext.html\">CDSHookPatientViewContext</a><br/>JSON: If<code>%resource.hook = 'order-sign'</code>then the type is<a href=\"StructureDefinition-CDSHookOrderSignContext.html\">CDSHookOrderSignContext</a><br/>JSON: If<code>%resource.hook = 'order-select'</code>then the type is<a href=\"StructureDefinition-CDSHookOrderSelectContext.html\">CDSHookOrderSelectContext</a></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck01.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.prefetch\" title=\"An object containing key/value pairs of FHIR queries that this Request is requesting the CDS Client to perform and provide on each Request call. The key is a string that describes the type of data being requested and the value is a string representing the FHIR query\">prefetch</a><a name=\"CDSHooksRequest.prefetch\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..*</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Base</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Key/value pairs of FHIR queries the CDS Client provides on each call<br/>JSON: Represented as a single JSON Object with named properties using the value of the key child as the key<br/></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck010.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.prefetch.key\" title=\"Key of FHIR query - name for client to use when sending to Request\">key</a><a name=\"CDSHooksRequest.prefetch.key\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#code\">code</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Key of FHIR query - name for client to use when sending to Request</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck000.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.prefetch.value\" title=\"Value of FHIR query - FHIR Query for client to perform\">value</a><a name=\"CDSHooksRequest.prefetch.value\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/resource.html\">Resource</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Value of FHIR query - FHIR Query for client to perform<br/>Id may or not be present (this is the default for elements but not resources)<br/>JSON: This object can be represented as null in the JSON structure (which counts as 'present' for cardinality purposes)</td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div><div xml:lang=\"es\" lang=\"es\"><hr/><p><b>Spanish</b></p><hr/><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition CDSHooksRequest</b></p><a name=\"CDSHooksRequest\"> </a><a name=\"hcCDSHooksRequest\"> </a><a name=\"CDSHooksRequest-es\"> </a><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest\" title=\"The response to the discovery endpoint\">CDSHooksRequest</a><a name=\"CDSHooksRequest\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;\" href=\"http://hl7.org/fhir/R5/conformance-rules.html#constraints\" title=\"This element has or is affected by constraints ( cds-r-1 )\">C</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-CDSHooksElement.html\">CDSHooksElement</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><br/>Elements defined in Ancestors:<a href=\"StructureDefinition-CDSHooksElement.html\" title=\"A JSON object that has properties where the names are defined by the extension definitions\">extension</a><br/>The response to the discovery endpoint<br/><span style=\"font-weight:bold\">Instances of this logical model are not marked to be the target of a Reference</span><br/><span style=\"font-weight:bold\">cds-r-1: </span>if fhirAuthorization details are provided, a fhirServer SHALL be specified</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.hook\" title=\"The hook that triggered this CDS Service call\">hook</a><a name=\"CDSHooksRequest.hook\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#code\">code</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The hook that triggered this CDS Service call</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.hookInstance\" title=\"While working in the CDS Client, a user can perform multiple actions in series or in parallel. For example, a clinician might prescribe two drugs in a row; each prescription action would be assigned a unique hookInstance. This allows a CDS Service to uniquely identify each hook invocation\">hookInstance</a><a name=\"CDSHooksRequest.hookInstance\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#uuid\">uuid</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">A universally unique identifier (UUID) for this particular hook call<br/>When this element is read <code>urn:uuid:</code> is prefixed to the value before validation</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.fhirServer\" title=\"The base URL of the CDS Client's FHIR server. If fhirAuthorization is provided, this field is REQUIRED. The scheme MUST be https when production data is exchanged\">fhirServer</a><a name=\"CDSHooksRequest.fhirServer\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#url\">url</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The base URL of the CDS Client's FHIR server</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck11.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization\" title=\"A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token\">fhirAuthorization</a><a name=\"CDSHooksRequest.fhirAuthorization\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;\" href=\"http://hl7.org/fhir/R5/conformance-rules.html#constraints\" title=\"This element has or is affected by constraints ( cds-r-2 )\">C</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-CDSHooksElement.html\">CDSHooksElement</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token<br/><span style=\"font-weight:bold\">cds-r-2: </span>If the granted SMART scopes include patient scopes (i.e. 'patient/'), the patient field SHOULD be populated to identify the FHIR id of that patient.</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck110.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization.accessToken\" title=\"This is the OAuth 2.0 access token that provides access to the FHIR server\">accessToken</a><a name=\"CDSHooksRequest.fhirAuthorization.accessToken\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">This is the OAuth 2.0 access token that provides access to the FHIR server<br/><span style=\"font-weight:bold\">JSON Property Name: </span>access_token</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck110.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization.tokenType\" title=\"Fixed value: Bearer\">tokenType</a><a name=\"CDSHooksRequest.fhirAuthorization.tokenType\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#code\">code</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Fixed value: Bearer<br/><span style=\"font-weight:bold\">JSON Property Name: </span>token_type<br/><span style=\"font-weight:bold\">Fixed Value: </span><span style=\"color: darkgreen\">Bearer</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck110.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization.expiresIn\" title=\"The lifetime in seconds of the access token.\">expiresIn</a><a name=\"CDSHooksRequest.fhirAuthorization.expiresIn\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#integer\">integer</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The lifetime in seconds of the access token.<br/><span style=\"font-weight:bold\">JSON Property Name: </span>expires_in</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck110.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization.scope\" title=\"The scopes the access token grants the CDS Service\">scope</a><a name=\"CDSHooksRequest.fhirAuthorization.scope\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The scopes the access token grants the CDS Service</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck110.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization.subject\" title=\"The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server\">subject</a><a name=\"CDSHooksRequest.fhirAuthorization.subject\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck100.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization.patient\" title=\"The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server\">patient</a><a name=\"CDSHooksRequest.fhirAuthorization.patient\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#id\">id</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.context\" title=\"Hook-specific contextual data that the CDS service will need\">context</a><a name=\"CDSHooksRequest.context\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-CDSHookContext.html\">CDSHookContext</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Hook-specific contextual data that the CDS service will need<br/>JSON: If<code>%resource.hook = 'patient-view'</code>then the type is<a href=\"StructureDefinition-CDSHookPatientViewContext.html\">CDSHookPatientViewContext</a><br/>JSON: If<code>%resource.hook = 'order-sign'</code>then the type is<a href=\"StructureDefinition-CDSHookOrderSignContext.html\">CDSHookOrderSignContext</a><br/>JSON: If<code>%resource.hook = 'order-select'</code>then the type is<a href=\"StructureDefinition-CDSHookOrderSelectContext.html\">CDSHookOrderSelectContext</a></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck01.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.prefetch\" title=\"An object containing key/value pairs of FHIR queries that this Request is requesting the CDS Client to perform and provide on each Request call. The key is a string that describes the type of data being requested and the value is a string representing the FHIR query\">prefetch</a><a name=\"CDSHooksRequest.prefetch\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..*</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Base</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Key/value pairs of FHIR queries the CDS Client provides on each call<br/>JSON: Represented as a single JSON Object with named properties using the value of the key child as the key<br/></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck010.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.prefetch.key\" title=\"Key of FHIR query - name for client to use when sending to Request\">key</a><a name=\"CDSHooksRequest.prefetch.key\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#code\">code</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Key of FHIR query - name for client to use when sending to Request</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck000.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksRequest-definitions.html#CDSHooksRequest.prefetch.value\" title=\"Value of FHIR query - FHIR Query for client to perform\">value</a><a name=\"CDSHooksRequest.prefetch.value\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/resource.html\">Resource</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Value of FHIR query - FHIR Query for client to perform<br/>Id may or not be present (this is the default for elements but not resources)<br/>JSON: This object can be represented as null in the JSON structure (which counts as 'present' for cardinality purposes)</td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksRequest",
"identifier" : [
{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.40.1.42.6"
}
],
"version" : "0.3.0",
"name" : "CDSHooksRequest",
"title" : "CDSHooks Request (Logical Definition)",
"status" : "draft",
"experimental" : true,
"date" : "2024-10-27T07:27:27+11:00",
"publisher" : "HL7 International / FHIR Infrastructure",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description" : "This structure is defined to allow the FHIR Validator to validate a CDSHooks Request Body. TODO: This content will be moved to the CDS Hooks specification in the future",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"fhirVersion" : "3.0.2",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksRequest",
"baseDefinition" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "CDSHooksRequest",
"path" : "CDSHooksRequest",
"short" : "The response to the discovery endpoint",
"definition" : "The response to the discovery endpoint",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "cds-r-1",
"severity" : "error",
"human" : "if fhirAuthorization details are provided, a fhirServer SHALL be specified",
"expression" : "fhirAuthorization.exists() implies fhirServer.exists()"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "CDSHooksRequest.extension",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-extension-style",
"valueCode" : "named-elements"
}
],
"path" : "CDSHooksRequest.extension",
"short" : "Object that has Named Extension Properties",
"definition" : "A JSON object that has properties where the names are defined by the extension definitions",
"comment" : "Extension structures SHOULD use a strategy for naming that ensures global uniqueness, such as reverse-domain-name notation, e.g. com.cds-hooks.sandbox.myextension-practitionerspecialty",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CDSHooksElement.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"
}
]
},
{
"id" : "CDSHooksRequest.hook",
"path" : "CDSHooksRequest.hook",
"short" : "The hook that triggered this CDS Service call",
"definition" : "The hook that triggered this CDS Service call",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CDSHooksRequest.hook",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "CDSHooksRequest.hookInstance",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/implied-string-prefix",
"valueString" : "urn:uuid:"
}
],
"path" : "CDSHooksRequest.hookInstance",
"short" : "A universally unique identifier (UUID) for this particular hook call",
"definition" : "While working in the CDS Client, a user can perform multiple actions in series or in parallel. For example, a clinician might prescribe two drugs in a row; each prescription action would be assigned a unique hookInstance. This allows a CDS Service to uniquely identify each hook invocation",
"comment" : "Note: the hookInstance is globally unique and should contain enough entropy to be un-guessable.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CDSHooksRequest.hookInstance",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "uuid"
}
]
},
{
"id" : "CDSHooksRequest.fhirServer",
"path" : "CDSHooksRequest.fhirServer",
"short" : "The base URL of the CDS Client's FHIR server",
"definition" : "The base URL of the CDS Client's FHIR server. If fhirAuthorization is provided, this field is REQUIRED. The scheme MUST be https when production data is exchanged",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CDSHooksRequest.fhirServer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "url"
}
]
},
{
"id" : "CDSHooksRequest.fhirAuthorization",
"path" : "CDSHooksRequest.fhirAuthorization",
"short" : "A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token",
"definition" : "A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CDSHooksRequest.fhirAuthorization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"
}
],
"constraint" : [
{
"key" : "cds-r-2",
"severity" : "error",
"human" : "If the granted SMART scopes include patient scopes (i.e. 'patient/'), the patient field SHOULD be populated to identify the FHIR id of that patient.",
"expression" : "scope.contains('Patient/') implies patient.exists()"
}
]
},
{
"id" : "CDSHooksRequest.fhirAuthorization.extension",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-extension-style",
"valueCode" : "named-elements"
}
],
"path" : "CDSHooksRequest.fhirAuthorization.extension",
"short" : "Object that has Named Extension Properties",
"definition" : "A JSON object that has properties where the names are defined by the extension definitions",
"comment" : "Extension structures SHOULD use a strategy for naming that ensures global uniqueness, such as reverse-domain-name notation, e.g. com.cds-hooks.sandbox.myextension-practitionerspecialty",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CDSHooksElement.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"
}
]
},
{
"id" : "CDSHooksRequest.fhirAuthorization.accessToken",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-json-name",
"valueString" : "access_token"
}
],
"path" : "CDSHooksRequest.fhirAuthorization.accessToken",
"short" : "This is the OAuth 2.0 access token that provides access to the FHIR server",
"definition" : "This is the OAuth 2.0 access token that provides access to the FHIR server",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CDSHooksRequest.fhirAuthorization.accessToken",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "CDSHooksRequest.fhirAuthorization.tokenType",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-json-name",
"valueString" : "token_type"
}
],
"path" : "CDSHooksRequest.fhirAuthorization.tokenType",
"short" : "Fixed value: Bearer",
"definition" : "Fixed value: Bearer",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CDSHooksRequest.fhirAuthorization.tokenType",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "Bearer"
},
{
"id" : "CDSHooksRequest.fhirAuthorization.expiresIn",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-json-name",
"valueString" : "expires_in"
}
],
"path" : "CDSHooksRequest.fhirAuthorization.expiresIn",
"short" : "The lifetime in seconds of the access token.",
"definition" : "The lifetime in seconds of the access token.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CDSHooksRequest.fhirAuthorization.expiresIn",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "integer"
}
]
},
{
"id" : "CDSHooksRequest.fhirAuthorization.scope",
"path" : "CDSHooksRequest.fhirAuthorization.scope",
"short" : "The scopes the access token grants the CDS Service",
"definition" : "The scopes the access token grants the CDS Service",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CDSHooksRequest.fhirAuthorization.scope",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "CDSHooksRequest.fhirAuthorization.subject",
"path" : "CDSHooksRequest.fhirAuthorization.subject",
"short" : "The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server",
"definition" : "The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CDSHooksRequest.fhirAuthorization.subject",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "CDSHooksRequest.fhirAuthorization.patient",
"path" : "CDSHooksRequest.fhirAuthorization.patient",
"short" : "The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server",
"definition" : "The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CDSHooksRequest.fhirAuthorization.patient",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "id"
}
]
},
{
"id" : "CDSHooksRequest.context",
"extension" : [
{
"extension" : [
{
"url" : "condition",
"valueString" : "%resource.hook = 'patient-view'"
},
{
"url" : "type",
"valueCode" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookPatientViewContext"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
},
{
"extension" : [
{
"url" : "condition",
"valueString" : "%resource.hook = 'order-sign'"
},
{
"url" : "type",
"valueCode" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookOrderSignContext"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
},
{
"extension" : [
{
"url" : "condition",
"valueString" : "%resource.hook = 'order-select'"
},
{
"url" : "type",
"valueCode" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookOrderSelectContext"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
}
],
"path" : "CDSHooksRequest.context",
"short" : "Hook-specific contextual data that the CDS service will need",
"definition" : "Hook-specific contextual data that the CDS service will need",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CDSHooksRequest.context",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookContext"
}
]
},
{
"id" : "CDSHooksRequest.prefetch",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/json-property-key",
"valueCode" : "key"
}
],
"path" : "CDSHooksRequest.prefetch",
"short" : "Key/value pairs of FHIR queries the CDS Client provides on each call",
"definition" : "An object containing key/value pairs of FHIR queries that this Request is requesting the CDS Client to perform and provide on each Request call. The key is a string that describes the type of data being requested and the value is a string representing the FHIR query",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CDSHooksRequest.prefetch",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Base"
}
]
},
{
"id" : "CDSHooksRequest.prefetch.key",
"path" : "CDSHooksRequest.prefetch.key",
"short" : "Key of FHIR query - name for client to use when sending to Request",
"definition" : "Key of FHIR query - name for client to use when sending to Request",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CDSHooksRequest.prefetch.key",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "CDSHooksRequest.prefetch.value",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/json-nullable",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/id-expectation",
"valueCode" : "optional"
}
],
"path" : "CDSHooksRequest.prefetch.value",
"short" : "Value of FHIR query - FHIR Query for client to perform",
"definition" : "Value of FHIR query - FHIR Query for client to perform",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CDSHooksRequest.prefetch.value",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Resource"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "CDSHooksRequest",
"path" : "CDSHooksRequest",
"short" : "The response to the discovery endpoint",
"definition" : "The response to the discovery endpoint",
"constraint" : [
{
"key" : "cds-r-1",
"severity" : "error",
"human" : "if fhirAuthorization details are provided, a fhirServer SHALL be specified",
"expression" : "fhirAuthorization.exists() implies fhirServer.exists()"
}
]
},
{
"id" : "CDSHooksRequest.hook",
"path" : "CDSHooksRequest.hook",
"short" : "The hook that triggered this CDS Service call",
"definition" : "The hook that triggered this CDS Service call",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "CDSHooksRequest.hookInstance",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/implied-string-prefix",
"valueString" : "urn:uuid:"
}
],
"path" : "CDSHooksRequest.hookInstance",
"short" : "A universally unique identifier (UUID) for this particular hook call",
"definition" : "While working in the CDS Client, a user can perform multiple actions in series or in parallel. For example, a clinician might prescribe two drugs in a row; each prescription action would be assigned a unique hookInstance. This allows a CDS Service to uniquely identify each hook invocation",
"comment" : "Note: the hookInstance is globally unique and should contain enough entropy to be un-guessable.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "uuid"
}
]
},
{
"id" : "CDSHooksRequest.fhirServer",
"path" : "CDSHooksRequest.fhirServer",
"short" : "The base URL of the CDS Client's FHIR server",
"definition" : "The base URL of the CDS Client's FHIR server. If fhirAuthorization is provided, this field is REQUIRED. The scheme MUST be https when production data is exchanged",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "url"
}
]
},
{
"id" : "CDSHooksRequest.fhirAuthorization",
"path" : "CDSHooksRequest.fhirAuthorization",
"short" : "A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token",
"definition" : "A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"
}
],
"constraint" : [
{
"key" : "cds-r-2",
"severity" : "error",
"human" : "If the granted SMART scopes include patient scopes (i.e. 'patient/'), the patient field SHOULD be populated to identify the FHIR id of that patient.",
"expression" : "scope.contains('Patient/') implies patient.exists()"
}
]
},
{
"id" : "CDSHooksRequest.fhirAuthorization.accessToken",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-json-name",
"valueString" : "access_token"
}
],
"path" : "CDSHooksRequest.fhirAuthorization.accessToken",
"short" : "This is the OAuth 2.0 access token that provides access to the FHIR server",
"definition" : "This is the OAuth 2.0 access token that provides access to the FHIR server",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "CDSHooksRequest.fhirAuthorization.tokenType",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-json-name",
"valueString" : "token_type"
}
],
"path" : "CDSHooksRequest.fhirAuthorization.tokenType",
"short" : "Fixed value: Bearer",
"definition" : "Fixed value: Bearer",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "Bearer"
},
{
"id" : "CDSHooksRequest.fhirAuthorization.expiresIn",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-json-name",
"valueString" : "expires_in"
}
],
"path" : "CDSHooksRequest.fhirAuthorization.expiresIn",
"short" : "The lifetime in seconds of the access token.",
"definition" : "The lifetime in seconds of the access token.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "integer"
}
]
},
{
"id" : "CDSHooksRequest.fhirAuthorization.scope",
"path" : "CDSHooksRequest.fhirAuthorization.scope",
"short" : "The scopes the access token grants the CDS Service",
"definition" : "The scopes the access token grants the CDS Service",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "CDSHooksRequest.fhirAuthorization.subject",
"path" : "CDSHooksRequest.fhirAuthorization.subject",
"short" : "The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server",
"definition" : "The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "CDSHooksRequest.fhirAuthorization.patient",
"path" : "CDSHooksRequest.fhirAuthorization.patient",
"short" : "The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server",
"definition" : "The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "id"
}
]
},
{
"id" : "CDSHooksRequest.context",
"extension" : [
{
"extension" : [
{
"url" : "condition",
"valueString" : "%resource.hook = 'patient-view'"
},
{
"url" : "type",
"valueCode" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookPatientViewContext"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
},
{
"extension" : [
{
"url" : "condition",
"valueString" : "%resource.hook = 'order-sign'"
},
{
"url" : "type",
"valueCode" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookOrderSignContext"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
},
{
"extension" : [
{
"url" : "condition",
"valueString" : "%resource.hook = 'order-select'"
},
{
"url" : "type",
"valueCode" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookOrderSelectContext"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
}
],
"path" : "CDSHooksRequest.context",
"short" : "Hook-specific contextual data that the CDS service will need",
"definition" : "Hook-specific contextual data that the CDS service will need",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookContext"
}
]
},
{
"id" : "CDSHooksRequest.prefetch",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/json-property-key",
"valueCode" : "key"
}
],
"path" : "CDSHooksRequest.prefetch",
"short" : "Key/value pairs of FHIR queries the CDS Client provides on each call",
"definition" : "An object containing key/value pairs of FHIR queries that this Request is requesting the CDS Client to perform and provide on each Request call. The key is a string that describes the type of data being requested and the value is a string representing the FHIR query",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "Base"
}
]
},
{
"id" : "CDSHooksRequest.prefetch.key",
"path" : "CDSHooksRequest.prefetch.key",
"short" : "Key of FHIR query - name for client to use when sending to Request",
"definition" : "Key of FHIR query - name for client to use when sending to Request",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "CDSHooksRequest.prefetch.value",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/json-nullable",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/id-expectation",
"valueCode" : "optional"
}
],
"path" : "CDSHooksRequest.prefetch.value",
"short" : "Value of FHIR query - FHIR Query for client to perform",
"definition" : "Value of FHIR query - FHIR Query for client to perform",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "Resource"
}
]
}
]
}
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.